home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3dm / audio / alGetEventResource.z / alGetEventResource
Encoding:
Text File  |  1998-10-20  |  4.3 KB  |  67 lines
  1.  
  2.  
  3.  
  4. aaaallllGGGGeeeettttEEEEvvvveeeennnnttttRRRReeeessssoooouuuurrrrcccceeee((((3333ddddmmmm))))                                aaaallllGGGGeeeettttEEEEvvvveeeennnnttttRRRReeeessssoooouuuurrrrcccceeee((((3333ddddmmmm))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      alGetEventResource - Return audio resource that posted event
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      ####iiiinnnncccclllluuuuddddeeee <<<<ddddmmmmeeeeddddiiiiaaaa////aaaauuuuddddiiiioooo....hhhh>>>>
  13.  
  14.      AAAALLLLvvvvaaaalllluuuueeee aaaallllGGGGeeeettttEEEEvvvveeeennnnttttRRRReeeessssoooouuuurrrrcccceeee((((AAAALLLLeeeevvvveeeennnntttt eeeevvvveeeennnntttt))))
  15.  
  16.  
  17. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRR
  18.      _e_v_e_n_t   expects an AAAALLLLeeeevvvveeeennnntttt structure initialized by aaaallllNNNNeeeexxxxttttEEEEvvvveeeennnntttt((((3333ddddmmmm)))) or
  19.              aaaallllCCCChhhheeeecccckkkkEEEEvvvveeeennnntttt((((3333ddddmmmm)))).
  20.  
  21. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  22.      aaaallllGGGGeeeettttEEEEvvvveeeennnnttttRRRReeeessssoooouuuurrrrcccceeee returns the value of the resource that posted the
  23.      event. A resource will post an event to an event queue if it was selected
  24.      through aaaallllSSSSeeeelllleeeeccccttttEEEEvvvveeeennnnttttssss((((3333ddddmmmm)))).
  25.  
  26.      It is important to note that the return value of aaaallllGGGGeeeettttEEEEvvvveeeennnnttttRRRReeeessssoooouuuurrrrcccceeee((((3333ddddmmmm))))
  27.      is not necessarily the same value of the resource that generated the
  28.      event.  Similar to aaaallllGGGGeeeettttPPPPaaaarrrraaaammmmssss((((3333ddddmmmm)))) and aaaallllQQQQuuuueeeerrrryyyyPPPPaaaarrrraaaammmmssss((((3333ddddmmmm)))), audio events
  29.      follow a resource hierarchy. For example, one can set AL_RATE on a
  30.      device, even though the parameter is really handled by the device's
  31.      clock-generator, a separate resource. Similarly, if one requests an event
  32.      for AL_RATE on a device, an event will be posted when the AL_RATE on its
  33.      clock-generator changes. In this case, we say that the device posted the
  34.      event, and that the clock-generator generated the event. To obtain the
  35.      value of the resource that generated the event, use
  36.      aaaallllGGGGeeeettttEEEEvvvveeeennnnttttSSSSrrrrccccRRRReeeessssoooouuuurrrrcccceeee((((3333ddddmmmm)))).
  37.  
  38. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  39.      Upon successful completion, aaaallllGGGGeeeettttEEEEvvvveeeennnnttttRRRReeeessssoooouuuurrrrcccceeee((((3333ddddmmmm)))) returns a non zero
  40.      resource.  Otherwise, it returns zero, and sets an error number. This
  41.      error number can be retrieved with oooosssseeeerrrrrrrroooorrrr((((3333CCCC)))).
  42.  
  43.      aaaallllGGGGeeeettttEEEEvvvveeeennnnttttRRRReeeessssoooouuuurrrrcccceeee can fail for the following reason:
  44.  
  45.      AAAALLLL____BBBBAAAADDDD____IIIINNNNVVVVAAAALLLLIIIIDDDD____EEEEVVVVEEEENNNNTTTT   _e_v_e_n_t is invalid or null.
  46.  
  47. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  48.      alNewEvent(3dm), alNextEvent(3dm), alCheckEvent(3dm), alParams(3dm),
  49.      alGetEventData(3dm), alGetParams(3dm), alGetEventSrcResource(3dm),
  50.      alQueryParams(3dm),oserror(3C)
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.